home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 7 / Apprentice-Release7.iso / Source Code / C / Applications / Python 1.4 / pbmplus / libtiff / README < prev    next >
Encoding:
Text File  |  1996-02-28  |  11.1 KB  |  227 lines  |  [TEXT/MPCC]
  1. $Header: /usr/people/sam/tiff/libtiff/RCS/README,v 1.17 93/08/26 14:58:20 sam Exp $
  2.  
  3. Configuration Comments:
  4. ----------------------
  5. Aside from the compression algorithm support, there are
  6. configuration-related defines that you can override in the Makefile
  7. or in the default configuration file tiffconf.h:
  8.  
  9. COLORIMETRY_SUPPORT
  10.         if this is defined, support for the colorimetry
  11.         tags will be compiled in.
  12. JPEG_SUPPORT    if this is defined, support for the JPEG-related
  13.         tags will be compiled in.  Note that at the present
  14.         time the JPEG compression support is not included.
  15. YCBCR_SUPPORT    if this is defined, support for the YCbCr-related
  16.         tags will be compiled in.  Note that you'll want
  17.         YCBCR support for JPEG compression+decompression.
  18. CMYK_SUPPORT    if this is defined, support for the CMYK-related
  19.         tags will be compiled in.
  20. MMAP_SUPPORT    if this is set, and OS support exists for memory
  21.         mapping files, then the library will try to map
  22.         a file if it is opened for reading.  If mmap does
  23.         not exist on your system, or the mmap call fails
  24.         on the file, then the normal read system calls are
  25.         used.  It is not clear how useful this facility is.
  26.  
  27. By default tiffconf.h defines COLORIMETRY_SUPPORT, JPEG_SUPPORT,
  28. YCBCR_SUPPORT, CMYK_SUPPORT.  MMAP_SUPPORT is not defined.
  29.  
  30. General Portability Comments:
  31. ----------------------------
  32. I run this code on SGI machines (big-endian, MIPS CPU, 32-bit ints,
  33. IEEE floating point).  Makefiles exist for other platforms that the
  34. code runs on -- this work has mostly been done by other people.
  35. The code runs on Macintosh and PC-based systems, although I don't
  36. know all the particulars.
  37.  
  38. In general, I promise only that the code runs on SGI machines.
  39. I will, however, gladly take back fixes to make it work on other
  40. systems -- when the changes are reasonable unobtrusive.
  41.  
  42. The software is written to assume an ANSI C compilation environment.
  43. If your compiler does not support ANSI function prototypes, const,
  44. and <stdarg.h> then you will have to make modifications to the
  45. software.  In the past I have tried to support compilers w/o const
  46. and systems w/o <stdarg.h>, but I am NO LONGER INTERESTED in these
  47. antiquated environments.  With the general availability of gcc, I
  48. see no reason to incorporate modifications to the software for these
  49. purposes.
  50.  
  51. I've tried to isolate as many of the OS-dependencies as possible in
  52. two files: tiffcomp.h and tif_<os>.c.  The latter file contains
  53. OS-specific routines to do I/O and I/O-related operations.  The
  54. UNIX (tif_unix.c), Macintosh (tif_apple.c), and VMS (tif_vms.c)
  55. code has had the most use; the MS/DOS support (tif_msdos.c) assumes
  56. some level of UNIX system call emulation (i.e. open, read, write,
  57. fstat, malloc, free).
  58.  
  59. Machine dependencies such as byte order are determined on the
  60. fly and do not need to be specified.
  61.  
  62. Two general portability-related defines are:
  63.  
  64. BSDTYPES    Define this if your system does NOT define the
  65.         usual BSD typedefs: u_char, u_short, u_int, u_longs.
  66. HAVE_IEEEFP    Define this as 0 or 1 according to the floating point
  67.         format suported by the machine.  If your machine does
  68.         not support IEEE floating point then you will need to
  69.         add support to tif_machdep.c to convert between the
  70.         native format and IEEE format.
  71.  
  72. Note that tiffcomp.h defines HAVE_IEEEFP to be 1 (BSDTYPES is not defined).
  73.  
  74. Types and Portability:
  75. ---------------------
  76. The software makes extensive use of typedefs to promote portability.
  77. Two sets of typedefs are used, one for communication with clients
  78. of the library and one for internal data structures and parsing of the
  79. TIFF format.  There are interactions between these two to be careful
  80. of, but for the most part you should be able to deal with portability
  81. purely by fiddling with the following machine-dependent typedefs:
  82.  
  83. uint16        16-bit unsigned integer        tiff.h
  84. int16        16-bit signed integer        tiff.h
  85. uint32        32-bit unsigned integer        tiff.h
  86. int32        32-bit signed integer        tiff.h
  87. dblparam_t    promoted type for floats    tiffcomp.h
  88.  
  89. (to clarify dblparam_t, it is the type that float parameters are
  90. promoted to when passed by value in a function call.)
  91.  
  92. The following typedefs are used throughout the library and interfaces
  93. to refer to certain objects whose size is dependent on the TIFF image
  94. structure:
  95.  
  96. typedef    unsigned int ttag_t;    directory tag
  97. typedef    uint16 tdir_t;        directory index
  98. typedef    uint16 tsample_t;    sample number
  99. typedef    uint32 tstrip_t;    strip number
  100. typedef uint32 ttile_t;        tile number
  101. typedef    int32 tsize_t;        i/o size in bytes
  102. typedef    void* tdata_t;        image data ref
  103. typedef    void* thandle_t;    client data handle
  104. typedef    int32 toff_t;        file offset (should be off_t)
  105. typedef    unsigned char* tidata_t;internal image data
  106.  
  107. Note that tstrip_t, ttile_t, and tsize_t are constrained to be
  108. no more than 32-bit quantities by 32-bit fields they are stored
  109. in in the TIFF image.  Likewise tsample_t is limited by the 16-bit
  110. field used to store the SamplesPerPixel tag.  tdir_t constrains
  111. the maximum number of IFDs that may appear in an image and may
  112. be an arbitrary size (w/o penalty).  ttag_t must be either int,
  113. unsigned int, pointer, or double because the library uses a varargs
  114. interface and ANSI restricts the type of the parameter before an
  115. ellipsis to be a promoted type.  toff_t is defined as int32 because
  116. TIFF file offsets are (unsigned) 32-bit quantities.  A signed
  117. value is used because some interfaces return -1 on error (sigh).
  118. Finally, note that tidata_t is used internally to the library to
  119. manipulate internal data.  User-specified data references are
  120. passed as opaque handles and only cast at the lowest layers where
  121. their type is presumed.
  122.  
  123. General Comments:
  124. ----------------
  125. The library is designed to hide as much of the details of TIFF as
  126. possible.  In particular, TIFF directories are read in their entirety
  127. into an internal format.  Only the tags known by the library are
  128. available to a user and certain tag data may be maintained that a user
  129. doesn't care about (e.g. transfer function tables).
  130.  
  131. To add support for a new directory tag the following mods are needed:
  132.  
  133. 1. Define the tag in tiff.h.
  134. 2. Add a field to the directory structure in tiffiop.h and define a
  135.    FIELD_* bit.
  136. 3. Add an entry in the FieldInfo array defined at the top of tiff_dirinfo.c.
  137. 4. Add entries in TIFFSetField1() and TIFFGetField1() for the new tag.
  138. 5. (optional) If the value associated with the tag is not a scalar value
  139.    (e.g. the array for TransferFunction), then add the appropriate
  140.    code to TIFFReadDirectory() and TIFFWriteDirectory().  You're best
  141.    off finding a similar tag and cribbing code.
  142. 6. Add support to TIFFPrintDirectory() in tiff_print.c to print the
  143.    tag's value.
  144.  
  145. If you want to maintain portability, beware of making assumptions
  146. about data types.  Use the typedefs (uint16, etc. when dealing with
  147. data on disk and t*_t when stuff is in memory) and be careful about
  148. passing items through printf or similar vararg interfaces.
  149.  
  150. To add support for a compression algorithm:
  151.  
  152. 1. Define the tag value in tiff.h.
  153. 2. Edit the file tiff_compress.c to add an entry to the
  154.    CompressionSchemes[] array.
  155. 3. Create a file with the compression scheme code, by convention files
  156.    are named tif_*.c (except perhaps on some systems where the tif_ prefix
  157.    pushes some filenames over 14 chars.
  158. 4. Edit the Makefiles to include the new source file.
  159.  
  160. A compression scheme, say foo, can have up to 10 entry points:
  161.  
  162. TIFFfoo(tif)        /* initialize scheme and setup entry points in tif */
  163. fooPreDecode(tif)    /* called once per strip, after data is read,
  164.                but before the first row in a strip is decoded */
  165. fooDecode*(tif, bp, cc, sample)/* decode cc bytes of data into the buffer */
  166.     fooDecodeRow(...)    /* called to decode a single scanline */
  167.     fooDecodeStrip(...)    /* called to decode an entire strip */
  168.     fooDecodeTile(...)    /* called to decode an entire tile */
  169. fooPreEncode(tif)    /* called once per strip/tile, before the first row in
  170.                a strip is encoded */
  171. fooEncode*(tif, bp, cc, sample)/* encode cc bytes of user data (bp) */
  172.     fooEncodeRow(...)    /* called to decode a single scanline */
  173.     fooEncodeStrip(...)    /* called to decode an entire strip */
  174.     fooEncodeTile(...)    /* called to decode an entire tile */
  175. fooPostEncode(tif)    /* called once per strip/tile, just before data is written */
  176. fooSeek(tif, row)    /* seek forwards row scanlines from the beginning
  177.                of a strip (row will always be >0 and <rows/strip */
  178. fooCleanup(tif)        /* called when compression scheme is replaced by user */
  179.  
  180. Note that the encoding and decoding variants are only needed when
  181. a compression algorithm is dependent on the structure of the data.
  182. For example, Group 3 2D encoding and decoding maintains a reference
  183. scanline.  The sample parameter identifies which sample is to be
  184. encoded or decoded if the image is organized with PlanarConfig=2
  185. (separate planes).  This is important for algorithms such as JPEG.
  186. If PlanarConfig=1 (interleaved), then sample will always be 0.
  187.  
  188. The library handles most I/O buffering.  There are two data buffers
  189. when decoding data: a raw data buffer that holds all the data in a
  190. strip, and a user-supplied scanline buffer that compression schemes
  191. place decoded data into.  When encoding data the data in the
  192. user-supplied scanline buffer is encoded into the raw data buffer (from
  193. where it's written).  Decoding routines should never have to explicitly
  194. read data -- a full strip/tile's worth of raw data is read and scanlines
  195. never cross strip boundaries.  Encoding routines must be cognizant of
  196. the raw data buffer size and call TIFFFlushData1() when necessary.
  197. Note that any pending data is automatically flushed when a new strip/tile is
  198. started, so there's no need do that in the tif_postencode routine (if
  199. one exists).  Bit order is automatically handled by the library when
  200. a raw strip or tile is filled.  If the decoded samples are interpreted
  201. by the decoding routine before they are passed back to the user, then
  202. the decoding logic must handle byte-swapping by overriding the tif_postdecode
  203. routine (set it to TIFFNoPostDecode) and doing the required work
  204. internally.  For an example of doing this look at the horizontal
  205. differencing code in the LZW decoding routines.
  206.  
  207. The variables tif_rawcc, tif_rawdata, and tif_rawcp in a TIFF structure
  208. are associated with the raw data buffer.  tif_rawcc must be non-zero
  209. for the library to automatically flush data.  The variable
  210. tif_scanlinesize is the size a user's scanline buffer should be.  The
  211. variable tif_tilesize is the size of a tile for tiled images.  This
  212. should not normally be used by compression routines, except where it
  213. relates to the compression algorithm.  That is, the cc parameter to the
  214. tif_decode* and tif_encode* routines should be used in terminating
  215. decompression/compression.  This ensures these routines can be used,
  216. for example, to decode/encode entire strips of data.
  217.  
  218. In general, if you have a new compression algorithm to add, work from
  219. the code for an existing routine.  In particular, tiff_dumpmode.c has
  220. the trivial code for the "nil" compression scheme, tiff_packbits.c is a
  221. simple byte-oriented scheme that has to watch out for buffer
  222. boundaries, and tiff_lzw.c has the LZW scheme that has the most
  223. complexity -- it tracks the buffer boundary at a bit level.
  224.  
  225. Of course, using a private compression scheme (or private tags) limits
  226. the portability of your TIFF files.
  227.